@fluentui/scheme-utilities

@fluentui/scheme-utilities

Theme variant generator for Fluent UI React (formerly Office UI Fabric React)

Variants are themes generated from an existing theme, as opposed to from raw colors. A variant will share the same colors as the original theme it was generated from, but will use those colors differently. For example, the background color and text color might be swapped. Variants can be used to highlight or de-emphasize portions of the page.

Example of normal, soft, and strong variants:

This project provides helper functions to create variants of a given theme, which can be used with the ThemeProvider component to theme a specific portion of the page. Each function takes in an IPartialTheme and returns an ITheme.

The following example creates a strong variant of a given theme, and applies that strong variant to the components wrapped by ThemeProvider.

import { FluentTheme } from '@fluentui/theme';
import { getStrongVariant } from '@fluentui/theme-schemes';

const strongTheme = getStrongVariant(FluentTheme);

<ThemeProvider theme={strongTheme}>
  <components... />
</ThemeProvider>

The available variants are:

• getNeutralVariant(theme: IPartialTheme): ITheme
  • Neutral - a soft neutral color is used as the background (light gray in the default theme), most other colors are changed very little or not at all
• getSoftVariant(theme: IPartialTheme): ITheme
  • Soft - a soft shade of the primary color is used as the background (light blue in the default theme), most other colors are changed very little or not at all, but input controls look different
• getStrongVariant(theme: IPartialTheme): ITheme
  • Strong - a strong shade of the primary color is used as the background (blue in the default theme), almost all colors are changed